Fix v1 auth monolith documentation and tooling #6194
Merged
+1,167
−260
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…stered:Explains compatibility for different schemasProvides more auth examplesFills missing schemes in API refFixes placeholdersShows that username is optional
There was a problem hiding this comment.
Pull Request Overview
This PR updates authentication examples for v1 compatibility across docs, consolidates shared snippets into inline code blocks, and adjusts tooling configuration paths for InfluxDB 3.
- Fixes
curl --usersyntax and query-string auth in documentation - Removes shared script snippets and embeds inline examples
- Updates Hugo healthchecks and test mounts to
influxdb3paths - Enhances OpenAPI specs with new security schemes and parameter definitions
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| shared/text/api/cloud-dedicated/querystring-auth.sh | Removed obsolete shared query-string auth snippet |
| shared/text/api/cloud-dedicated/basic-auth.sh | Removed obsolete shared basic-auth snippet |
| content/shared/.../compatibility-apis.md | Added v1/v2 token auth sections and examples inline |
| content/.../influxdb-v1-api.md | Updated query examples to use --user "any:TOKEN" |
| compose.yaml | Adjusted healthcheck URL and CONTENT_PATH to influxdb3 |
| api-docs/**/v3/ref.yml | Introduced BasicAuthentication, TokenAuthentication, and QuerystringAuthentication schemes |
Comments suppressed due to low confidence (2)
content/influxdb3/cloud-dedicated/write-data/_index.md:26
- [nitpick] Use a shell-specific code block (e.g.,
sh orbash) instead of ```http for shell/cURL examples to improve syntax highlighting.
> When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
api-docs/influxdb3/enterprise/v3/ref.yml:42
- Verify that the security scheme key
BearerAuthenticationmatches the component definition and that all references to the oldBearerAuthkey have been updated accordingly to avoid broken links in the spec.
- BearerAuthentication: []
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
sanderson
approved these changes
Jul 8, 2025
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
🤖 Generated with Claude Code